Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename runtime configs to something more generic #604

Merged
merged 4 commits into from
Jul 5, 2023

Conversation

echevrier
Copy link
Contributor

@echevrier echevrier commented Jul 4, 2023

Rename SubstratKitchensinkConfig into AssetRuntimeConfig
Rename PolkadotConfig into DefaultRuntimeConfig
Close ##586

@@ -17,9 +17,9 @@ use core::fmt::Debug;

/// Default set of commonly used types by Substrate kitchensink runtime.
#[derive(Decode, Encode, Clone, Eq, PartialEq, Debug)]
pub struct SubstrateKitchensinkConfig {}
Copy link
Contributor

@haerdib haerdib Jul 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, thanks a lot! To avoid a lot of confusion: What would you think about defining a "new" type that has the same name as the old one, but marked with a deprecated?

E.g.

#[deprecated(since="0.14.0", note="Please use `AssetRuntimeConfig` instead, this will be removed in the next release.")]
pub type SubstrateKitchensinkConfig  = AssetRuntimeConfig;

Same for the PolkadotConfig.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the "since" works for future releases, but it would certainly help us to note how old the deprecated text is and when to remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Contributor

@Niederb Niederb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😄

Copy link
Contributor

@haerdib haerdib left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥳

@echevrier echevrier merged commit dd6ca5e into master Jul 5, 2023
37 checks passed
@echevrier echevrier deleted the ec/rename_runtime_configs branch July 5, 2023 08:23
@haerdib haerdib mentioned this pull request Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate: Rename SubstrateKitchensinkConfig to something more generic
3 participants